home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Xm / XmStringParseText.z / XmStringParseText
Encoding:
Text File  |  2001-04-17  |  8.9 KB  |  133 lines

  1.  
  2.  
  3.  
  4.      XXXXmmmmSSSSttttrrrriiiinnnnggggPPPPaaaarrrrsssseeeeTTTTeeeexxxxtttt((((3333XXXX))))     UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV     XXXXmmmmSSSSttttrrrriiiinnnnggggPPPPaaaarrrrsssseeeeTTTTeeeexxxxtttt((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmSSSSttttrrrriiiinnnnggggPPPPaaaarrrrsssseeeeTTTTeeeexxxxtttt - A function that converts a character
  10.           string to a compound string
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/Xm.h>
  14.           XXXXmmmmSSSSttttrrrriiiinnnngggg XXXXmmmmSSSSttttrrrriiiinnnnggggPPPPaaaarrrrsssseeeeTTTTeeeexxxxtttt(
  15.           XXXXttttPPPPooooiiiinnnntttteeeerrrr tttteeeexxxxtttt,
  16.           XXXXttttPPPPooooiiiinnnntttteeeerrrr ****tttteeeexxxxtttt____eeeennnndddd,
  17.           XXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaagggg ttttaaaagggg,
  18.           XXXXmmmmTTTTeeeexxxxttttTTTTyyyyppppeeee ttttyyyyppppeeee,
  19.           XXXXmmmmPPPPaaaarrrrsssseeeeTTTTaaaabbbblllleeee ppppaaaarrrrsssseeee____ttttaaaabbbblllleeee,
  20.           CCCCaaaarrrrddddiiiinnnnaaaallll ppppaaaarrrrsssseeee____ccccoooouuuunnnntttt,
  21.           XXXXttttPPPPooooiiiinnnntttteeeerrrr ccccaaaallllllll____ddddaaaattttaaaa);
  22.  
  23.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  24.           This page documents Motif 2.1.
  25.  
  26.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  27.           XXXXmmmmSSSSttttrrrriiiinnnnggggPPPPaaaarrrrsssseeeeTTTTeeeexxxxtttt converts characters specified in _t_e_x_t to
  28.           corresponding components in the returned compound string.
  29.           The resulting compound string consists of at least one
  30.           locale or charset tag component and a series of XXXXmmmmSSSSttttrrrriiiinnnngggg
  31.           text components and other components. The conversion
  32.           proceeds according to the parse information contained in
  33.           _p_a_r_s_e__t_a_b_l_e. See the _M_o_t_i_f _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e for more
  34.           information about parsing and parse tables.
  35.  
  36.              +o  If _t_y_p_e is XXXXmmmmCCCCHHHHAAAARRRRSSSSEEEETTTT____TTTTEEEEXXXXTTTT, the associated _t_a_g is
  37.                 interpreted as a charset name.  If _t_a_g has a value of
  38.                 NULL, a charset component whose value is the result of
  39.                 mapping XXXXmmmmFFFFOOOONNNNTTTTLLLLIIIISSSSTTTT____DDDDEEEEFFFFAAAAUUUULLLLTTTT____TTTTAAAAGGGGis created.
  40.  
  41.              +o  If _t_y_p_e is XXXXmmmmMMMMUUUULLLLTTTTIIIIBBBBYYYYTTTTEEEE____TTTTEEEEXXXXTTTT or XXXXmmmmWWWWIIIIDDDDEEEECCCCHHHHAAAARRRR____TTTTEEEEXXXXTTTT, the
  42.                 associated _t_a_g is interpreted as a language
  43.                 environment name.  If _t_a_g has a value of NULL, a
  44.                 locale component with a value of ____MMMMOOOOTTTTIIIIFFFF____DDDDEEEEFFFFAAAAUUUULLLLTTTT____LLLLOOOOCCCCAAAALLLLEEEE
  45.                 is created.  If _t_y_p_e is XXXXmmmmMMMMUUUULLLLTTTTIIIIBBBBYYYYTTTTEEEE____TTTTEEEEXXXXTTTT or
  46.                 XXXXmmmmWWWWIIIIDDDDEEEECCCCHHHHAAAARRRR____TTTTEEEEXXXXTTTT, _t_a_g must be NULL or
  47.                 ____MMMMOOOOTTTTIIIIFFFF____DDDDEEEEFFFFAAAAUUUULLLLTTTT____LLLLOOOOCCCCAAAALLLLEEEE.
  48.  
  49.           XXXXmmmmSSSSttttrrrriiiinnnnggggPPPPaaaarrrrsssseeeeTTTTeeeexxxxtttt also scans the string for characters that
  50.           have matches in _p_a_r_s_e__t_a_b_l_e.  Whenever a match is found, the
  51.           text up to that point is concatenated with the mapped
  52.           component.
  53.  
  54.           _t_e_x_t      Specifies the NULL-terminated string containing
  55.                     characters of a type determined by _t_y_p_e.  This is
  56.                     updated to point to after the last character
  57.                     scanned.
  58.  
  59.           _t_e_x_t__e_n_d  Specifies a pointer into _t_e_x_t. If a NULL is
  60.  
  61.  
  62.  
  63.      Page 1                                           (printed 4/6/01)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmSSSSttttrrrriiiinnnnggggPPPPaaaarrrrsssseeeeTTTTeeeexxxxtttt((((3333XXXX))))     UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV     XXXXmmmmSSSSttttrrrriiiinnnnggggPPPPaaaarrrrsssseeeeTTTTeeeexxxxtttt((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                     supplied to the _t_e_x_t__e_n_d parameter, then
  75.                     XXXXmmmmSSSSttttrrrriiiinnnnggggPPPPaaaarrrrsssseeeeTTTTeeeexxxxtttt parses _t_e_x_t until NULL is
  76.                     encountered, or until it reaches a point in
  77.                     _t_e_x_twhere it is directed to stop (for example, by
  78.                     a ppppaaaarrrrsssseeee____pppprrrroooocccc). Otherwise, the value supplied to
  79.                     the _t_e_x_t__e_n_d parameter is the pointer into _t_e_x_t
  80.                     where parsing is to stop, and the returned
  81.                     character is the one where parsing did stop.
  82.  
  83.           _t_a_g       Specifies the tag to be used in creating the
  84.                     result.  The type of string tag created (charset
  85.                     or locale) depends on the text type and the passed
  86.                     in _t_a_g value.  If the _t_a_g value is NULL and if
  87.                     _t_y_p_e indicates that a charset string tag should be
  88.                     created, the string tag has the value that is the
  89.                     result of mapping XXXXmmmmFFFFOOOONNNNTTTTLLLLIIIISSSSTTTT____DDDDEEEEFFFFAAAAUUUULLLLTTTT____TTTTAAAAGGGG.  If _t_y_p_e
  90.                     indicates a locale string tag, the string tag has
  91.                     the value ____MMMMOOOOTTTTIIIIFFFF____DDDDEEEEFFFFAAAAUUUULLLLTTTT____LLLLOOOOCCCCAAAALLLLEEEE.
  92.  
  93.           _t_y_p_e      Specifies the type of text and the tag type.  If a
  94.                     locale tag should be created, _t_y_p_e has a value of
  95.                     either XXXXmmmmMMMMUUUULLLLTTTTIIIIBBBBYYYYTTTTEEEE____TTTTEEEEXXXXTTTT or XXXXmmmmWWWWIIIIDDDDEEEECCCCHHHHAAAARRRR____TTTTEEEEXXXXTTTT.  If
  96.                     _t_y_p_e has value of XXXXmmmmCCCCHHHHAAAARRRRSSSSEEEETTTT____TTTTEEEEXXXXTTTT, a charset tag
  97.                     will be created.
  98.  
  99.           _p_a_r_s_e__t_a_b_l_e
  100.                     Specifies the parse table to be used in scanning
  101.                     for characters to be converted to other compound
  102.                     string components.
  103.  
  104.           _p_a_r_s_e__c_o_u_n_t
  105.                     Specifies the number of entries in _p_a_r_s_e__t_a_b_l_e.
  106.  
  107.           _c_a_l_l__d_a_t_a Specifies data to be passed to the parse
  108.                     procedures.
  109.  
  110.      RRRREEEETTTTUUUURRRRNNNN
  111.           Returns a new compound string.  The function allocates space
  112.           to hold the returned compound string.  When the application
  113.           no longer needs the returned compound string, the
  114.           application should call XXXXmmmmSSSSttttrrrriiiinnnnggggFFFFrrrreeeeeeee.
  115.  
  116.      RRRREEEELLLLAAAATTTTEEEEDDDD
  117.           XXXXmmmmSSSSttttrrrriiiinnnngggg(3), XXXXmmmmSSSSttttrrrriiiinnnnggggFFFFrrrreeeeeeee(3), XXXXmmmmPPPPaaaarrrrsssseeeeTTTTaaaabbbblllleeee(3),
  118.           XXXXmmmmPPPPaaaarrrrsssseeeeMMMMaaaappppppppiiiinnnngggg(3).
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                           (printed 4/6/01)
  130.  
  131.  
  132.  
  133.